<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
BitField (POI API Documentation)
</TITLE>

<META NAME="keywords" CONTENT="org.apache.poi.util.BitField class">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    parent.document.title="BitField (POI API Documentation)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BitField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/poi/util/BinaryTree.html" title="class in org.apache.poi.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/poi/util/BitFieldFactory.html" title="class in org.apache.poi.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/apache/poi/util/BitField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="BitField.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.poi.util</FONT>
<BR>
Class BitField</H2>
<PRE>
java.lang.Object
  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.poi.util.BitField</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>BitField</B><DT>extends java.lang.Object</DL>
</PRE>

<P>
Manage operations dealing with bit-mapped fields.
<P>

<P>
<DL>
<DT><B>Author:</B></DT>
  <DD>Marc Johnson (mjohnson at apache dot org), Andrew C. Oliver (acoliver at apache dot org)</DD>
</DL>
<HR>

<P>

<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#BitField(int)">BitField</A></B>(int&nbsp;mask)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a BitField instance</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#clear(int)">clear</A></B>(int&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Clear the bits.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#clearByte(byte)">clearByte</A></B>(byte&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Clear the bits.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#clearShort(short)">clearShort</A></B>(short&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Clear the bits.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#getRawValue(int)">getRawValue</A></B>(int&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtain the value for the specified BitField, unshifted</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#getShortRawValue(short)">getShortRawValue</A></B>(short&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtain the value for the specified BitField, unshifted</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#getShortValue(short)">getShortValue</A></B>(short&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtain the value for the specified BitField, appropriately
 shifted right, as a short.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#getValue(int)">getValue</A></B>(int&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtain the value for the specified BitField, appropriately
 shifted right.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#isAllSet(int)">isAllSet</A></B>(int&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Are all of the bits set or not? This is a stricter test than
 isSet, in that all of the bits in a multi-bit set must be set
 for this method to return true</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#isSet(int)">isSet</A></B>(int&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Is the field set or not? This is most commonly used for a
 single-bit field, which is often used to represent a boolean
 value; the results of using it for a multi-bit field is to
 determine whether *any* of its bits are set</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#set(int)">set</A></B>(int&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the bits.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#setBoolean(int, boolean)">setBoolean</A></B>(int&nbsp;holder,
           boolean&nbsp;flag)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a boolean BitField</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#setByte(byte)">setByte</A></B>(byte&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the bits.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#setByteBoolean(byte, boolean)">setByteBoolean</A></B>(byte&nbsp;holder,
               boolean&nbsp;flag)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a boolean BitField</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#setShort(short)">setShort</A></B>(short&nbsp;holder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the bits.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#setShortBoolean(short, boolean)">setShortBoolean</A></B>(short&nbsp;holder,
                boolean&nbsp;flag)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a boolean BitField</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#setShortValue(short, short)">setShortValue</A></B>(short&nbsp;holder,
              short&nbsp;value)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replace the bits with new values.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/poi/util/BitField.html#setValue(int, int)">setValue</A></B>(int&nbsp;holder,
         int&nbsp;value)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replace the bits with new values.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="BitField(int)"><!-- --></A><H3>
BitField</H3>
<PRE>
public <B>BitField</B>(int&nbsp;mask)</PRE>
<DL>
<DD>Create a BitField instance
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>mask</CODE> - the mask specifying which bits apply to this
             BitField. Bits that are set in this mask are the
             bits that this BitField operates on</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getValue(int)"><!-- --></A><H3>
getValue</H3>
<PRE>
public int <B>getValue</B>(int&nbsp;holder)</PRE>
<DL>
<DD>Obtain the value for the specified BitField, appropriately
 shifted right. Many users of a BitField will want to treat the
 specified bits as an int value, and will not want to be aware
 that the value is stored as a BitField (and so shifted left so
 many bits)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the int data containing the bits we're interested
               in
<DT><B>Returns:</B><DD>the selected bits, shifted right appropriately</DL>
</DD>
</DL>
<HR>

<A NAME="getShortValue(short)"><!-- --></A><H3>
getShortValue</H3>
<PRE>
public short <B>getShortValue</B>(short&nbsp;holder)</PRE>
<DL>
<DD>Obtain the value for the specified BitField, appropriately
 shifted right, as a short. Many users of a BitField will want
 to treat the specified bits as an int value, and will not want
 to be aware that the value is stored as a BitField (and so
 shifted left so many bits)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the short data containing the bits we're
               interested in
<DT><B>Returns:</B><DD>the selected bits, shifted right appropriately</DL>
</DD>
</DL>
<HR>

<A NAME="getRawValue(int)"><!-- --></A><H3>
getRawValue</H3>
<PRE>
public int <B>getRawValue</B>(int&nbsp;holder)</PRE>
<DL>
<DD>Obtain the value for the specified BitField, unshifted
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the int data containing the bits we're interested
               in
<DT><B>Returns:</B><DD>the selected bits</DL>
</DD>
</DL>
<HR>

<A NAME="getShortRawValue(short)"><!-- --></A><H3>
getShortRawValue</H3>
<PRE>
public short <B>getShortRawValue</B>(short&nbsp;holder)</PRE>
<DL>
<DD>Obtain the value for the specified BitField, unshifted
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the short data containing the bits we're
               interested in
<DT><B>Returns:</B><DD>the selected bits</DL>
</DD>
</DL>
<HR>

<A NAME="isSet(int)"><!-- --></A><H3>
isSet</H3>
<PRE>
public boolean <B>isSet</B>(int&nbsp;holder)</PRE>
<DL>
<DD>Is the field set or not? This is most commonly used for a
 single-bit field, which is often used to represent a boolean
 value; the results of using it for a multi-bit field is to
 determine whether *any* of its bits are set
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the int data containing the bits we're interested
               in
<DT><B>Returns:</B><DD>true if any of the bits are set, else false</DL>
</DD>
</DL>
<HR>

<A NAME="isAllSet(int)"><!-- --></A><H3>
isAllSet</H3>
<PRE>
public boolean <B>isAllSet</B>(int&nbsp;holder)</PRE>
<DL>
<DD>Are all of the bits set or not? This is a stricter test than
 isSet, in that all of the bits in a multi-bit set must be set
 for this method to return true
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the int data containing the bits we're interested
               in
<DT><B>Returns:</B><DD>true if all of the bits are set, else false</DL>
</DD>
</DL>
<HR>

<A NAME="setValue(int, int)"><!-- --></A><H3>
setValue</H3>
<PRE>
public int <B>setValue</B>(int&nbsp;holder,
                    int&nbsp;value)</PRE>
<DL>
<DD>Replace the bits with new values.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the int data containint the bits we're interested
               in<DD><CODE>value</CODE> - the new value for the specified bits
<DT><B>Returns:</B><DD>the value of holder with the bits from the value
         parameter replacing the old bits</DL>
</DD>
</DL>
<HR>

<A NAME="setShortValue(short, short)"><!-- --></A><H3>
setShortValue</H3>
<PRE>
public short <B>setShortValue</B>(short&nbsp;holder,
                           short&nbsp;value)</PRE>
<DL>
<DD>Replace the bits with new values.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the short data containing the bits we're
               interested in<DD><CODE>value</CODE> - the new value for the specified bits
<DT><B>Returns:</B><DD>the value of holder with the bits from the value
         parameter replacing the old bits</DL>
</DD>
</DL>
<HR>

<A NAME="clear(int)"><!-- --></A><H3>
clear</H3>
<PRE>
public int <B>clear</B>(int&nbsp;holder)</PRE>
<DL>
<DD>Clear the bits.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the int data containing the bits we're interested
               in
<DT><B>Returns:</B><DD>the value of holder with the specified bits cleared
         (set to 0)</DL>
</DD>
</DL>
<HR>

<A NAME="clearShort(short)"><!-- --></A><H3>
clearShort</H3>
<PRE>
public short <B>clearShort</B>(short&nbsp;holder)</PRE>
<DL>
<DD>Clear the bits.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the short data containing the bits we're
               interested in
<DT><B>Returns:</B><DD>the value of holder with the specified bits cleared
         (set to 0)</DL>
</DD>
</DL>
<HR>

<A NAME="clearByte(byte)"><!-- --></A><H3>
clearByte</H3>
<PRE>
public byte <B>clearByte</B>(byte&nbsp;holder)</PRE>
<DL>
<DD>Clear the bits.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the byte data containing the bits we're
               interested in
<DT><B>Returns:</B><DD>the value of holder with the specified bits cleared
         (set to 0)</DL>
</DD>
</DL>
<HR>

<A NAME="set(int)"><!-- --></A><H3>
set</H3>
<PRE>
public int <B>set</B>(int&nbsp;holder)</PRE>
<DL>
<DD>Set the bits.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the int data containing the bits we're interested
               in
<DT><B>Returns:</B><DD>the value of holder with the specified bits set to 1</DL>
</DD>
</DL>
<HR>

<A NAME="setShort(short)"><!-- --></A><H3>
setShort</H3>
<PRE>
public short <B>setShort</B>(short&nbsp;holder)</PRE>
<DL>
<DD>Set the bits.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the short data containing the bits we're
               interested in
<DT><B>Returns:</B><DD>the value of holder with the specified bits set to 1</DL>
</DD>
</DL>
<HR>

<A NAME="setByte(byte)"><!-- --></A><H3>
setByte</H3>
<PRE>
public byte <B>setByte</B>(byte&nbsp;holder)</PRE>
<DL>
<DD>Set the bits.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the byte data containing the bits we're
               interested in
<DT><B>Returns:</B><DD>the value of holder with the specified bits set to 1</DL>
</DD>
</DL>
<HR>

<A NAME="setBoolean(int, boolean)"><!-- --></A><H3>
setBoolean</H3>
<PRE>
public int <B>setBoolean</B>(int&nbsp;holder,
                      boolean&nbsp;flag)</PRE>
<DL>
<DD>Set a boolean BitField
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the int data containing the bits we're interested
               in<DD><CODE>flag</CODE> - indicating whether to set or clear the bits
<DT><B>Returns:</B><DD>the value of holder with the specified bits set or
         cleared</DL>
</DD>
</DL>
<HR>

<A NAME="setShortBoolean(short, boolean)"><!-- --></A><H3>
setShortBoolean</H3>
<PRE>
public short <B>setShortBoolean</B>(short&nbsp;holder,
                             boolean&nbsp;flag)</PRE>
<DL>
<DD>Set a boolean BitField
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the short data containing the bits we're
               interested in<DD><CODE>flag</CODE> - indicating whether to set or clear the bits
<DT><B>Returns:</B><DD>the value of holder with the specified bits set or
         cleared</DL>
</DD>
</DL>
<HR>

<A NAME="setByteBoolean(byte, boolean)"><!-- --></A><H3>
setByteBoolean</H3>
<PRE>
public byte <B>setByteBoolean</B>(byte&nbsp;holder,
                           boolean&nbsp;flag)</PRE>
<DL>
<DD>Set a boolean BitField
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>holder</CODE> - the byte data containing the bits we're
               interested in<DD><CODE>flag</CODE> - indicating whether to set or clear the bits
<DT><B>Returns:</B><DD>the value of holder with the specified bits set or
         cleared</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BitField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/poi/util/BinaryTree.html" title="class in org.apache.poi.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/poi/util/BitFieldFactory.html" title="class in org.apache.poi.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/apache/poi/util/BitField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="BitField.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            
</BODY>
</HTML>
